feat(docs): Add workflow to automate docs and license generation by OliverTrautvetter · Pull Request #38 · codesphere-cloud/oms

OliverTrautvetter · 2025-10-14T09:09:00Z

feat: Automate documentation and license updates

Adds a GitHub Workflow to automatically update all relevant documentation and license information within OMS upon Pull Request.

ClickUp Card

NautiluX

Thanks for the PR! I think running the workflow on the PR would actually be good enough. Please see my comments and 🥁 add a description ;)

.github/workflows/update-docs-and-licenses.yml

hack/update-docs-and-licenses.sh

Co-authored-by: Simon Herrmann <simonh@codesphere.com> Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

* Adds a description to the service command * Updates README Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Signed-off-by: GitHub Action <action@github.com> Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

NautiluX

couple comments on the bash script, it looks somehow overly complicated

docs/oms_download_package.md

hack/update-docs-and-licenses.sh

.github/workflows/update-docs-and-licenses.yml

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

…here-cloud/oms into automate_docs_and_license

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

…equired test files

… modify tar generation command

… of directory

…bedded file

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

NautiluX

thanks for updating the binary name! I'm confused by the checkout HEAD logic in the action, would you mind leaving a comment to explain why we need it?

hack/gendocs/main.go

hack/update-docs-and-licenses.sh

OliverTrautvetter · 2025-10-17T08:10:05Z

thanks for updating the binary name! I'm confused by the checkout HEAD logic in the action, would you mind leaving a comment to explain why we need it?

ref: ${{ github.event.pull_request.head.ref || github.ref }}

github.event.pull_request.head.ref = if it is a pull request, so Pull Request Branch
github.ref_name = if push to Main

Without this it would always try to push to the standard, so main.

I took the logic from the monorepo where we use it a few times for such things.

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

… in documentation without changing args

…tency with project naming

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

NautiluX · 2025-10-17T14:13:33Z

thanks for updating the binary name! I'm confused by the checkout HEAD logic in the action, would you mind leaving a comment to explain why we need it?

ref: ${{ github.event.pull_request.head.ref || github.ref }}

github.event.pull_request.head.ref = if it is a pull request, so Pull Request Branch github.ref_name = if push to Main

Without this it would always try to push to the standard, so main.

I took the logic from the monorepo where we use it a few times for such things.

This is on the checkout action, and as far as I understand the action runs only on pull requests, so github.event.pull_request.head.ref should always be set, right?

NautiluX

approving, left 2 smaller comments, the binary name should be updated, the cd repo_root thing doesn't hurt I guess, but I don't get why we need it.

hack/gendocs/main.go

hack/update-docs-and-licenses.sh

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

…s are captured correctly

…script

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

github-actions bot force-pushed the automate_docs_and_license branch 2 times, most recently from 45b9bb8 to 23a92d5 Compare October 14, 2025 09:12

NautiluX reviewed Oct 14, 2025

View reviewed changes

OliverTrautvetter force-pushed the automate_docs_and_license branch from e05ce74 to 8884bb1 Compare October 14, 2025 12:31

NautiluX and others added 13 commits October 14, 2025 14:39

feat: Extend baseimage (#25)

87cb75f

Co-authored-by: Simon Herrmann <simonh@codesphere.com> Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

feat: List api key (#30)

8324c7c

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

feat: Extend api key (#29)

03d4143

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

docs: Describe service root command, update README (#32)

b12a088

* Adds a description to the service command * Updates README Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

feat(docs): Add workflow to automate docs and license generation

99a6f9f

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

feat(docs): Add workflow to automate docs and license generation

521d4e0

Signed-off-by: GitHub Action <action@github.com> Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

fix: try to make it less weird

389ddd1

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

fix: add go to workflow to update license

ba1294a

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

chore(docs): Auto-update docs and licenses

16d13cf

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

fix: update and simplify workflow for docs and licenses generation

a512f99

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

fix: maybe fix workflow

6920318

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

chore(docs): Auto-update docs and licenses

796d99e

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

chore(docs): Auto-update docs and licenses

4756e49

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

OliverTrautvetter force-pushed the automate_docs_and_license branch from 78346c0 to 4756e49 Compare October 14, 2025 12:40

OliverTrautvetter added 3 commits October 14, 2025 14:44

fix: minor change to check workflow trigger

5cd17df

Merge branch 'main' into automate_docs_and_license

cc204d1

chore(docs): Auto-update docs and licenses

d40723a

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

NautiluX reviewed Oct 15, 2025

View reviewed changes

docs/oms_download_package.md Outdated Show resolved Hide resolved

hack/update-docs-and-licenses.sh Outdated Show resolved Hide resolved

hack/update-docs-and-licenses.sh Outdated Show resolved Hide resolved

NautiluX reviewed Oct 15, 2025

View reviewed changes

.github/workflows/update-docs-and-licenses.yml Show resolved Hide resolved

OliverTrautvetter added 7 commits October 15, 2025 18:10

Merge branch 'main' into automate_docs_and_license

26bb384

chore(docs): Auto-update docs and licenses

642cbc1

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

fix: prevent temp path in docs

e3e47e8

chore(docs): Auto-update docs and licenses

1c62324

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

refactor: simplify update-docs-and-licenses script

706ab85

Merge branch 'automate_docs_and_license' of https://github.com/codesp…

6902939

…here-cloud/oms into automate_docs_and_license

chore(docs): Auto-update docs and licenses

0a1030b

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

OliverTrautvetter added 8 commits October 16, 2025 10:14

ci: ignore and untrack internal util testdata fixtures

7a0c95e

ci: keep testdata dir, ignore its contents; add .gitkeep

07660bb

fix: update .gitignore to ignore specific testdata file and restore r…

67aee9f

…equired test files

fix: update .gitignore to ignore internal util testdata directory and…

6806147

… modify tar generation command

fix: update embed directive to reference specific tar.gz file instead…

51d0bad

… of directory

fix: refactor tar_test to create in-memory tar.gz instead of using em…

6590378

…bedded file

Merge branch 'main' into automate_docs_and_license

a010fc5

chore(docs): Auto-update docs and licenses

6e903c4

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

NautiluX reviewed Oct 16, 2025

View reviewed changes

hack/gendocs/main.go Outdated Show resolved Hide resolved

hack/update-docs-and-licenses.sh Outdated Show resolved Hide resolved

hack/update-docs-and-licenses.sh Outdated Show resolved Hide resolved

OliverTrautvetter added 7 commits October 17, 2025 10:14

fix: update main binary name to 'oms-cli' and simplify update script

684deab

chore(docs): Auto-update docs and licenses

349b4fe

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Merge branch 'main' into automate_docs_and_license

c4f4fb8

chore(docs): Auto-update docs and licenses

b4032fb

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

fix: improve command example formatting and ensure stable binary name…

9930190

… in documentation without changing args

fix: update command name in documentation generation to ensure consis…

89d0c08

…tency with project naming

chore(docs): Auto-update docs and licenses

5edc3a9

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

NautiluX approved these changes Oct 17, 2025

View reviewed changes

hack/gendocs/main.go Outdated Show resolved Hide resolved

hack/update-docs-and-licenses.sh Outdated Show resolved Hide resolved

OliverTrautvetter added 9 commits October 23, 2025 09:30

Merge branch 'main' into automate_docs_and_license

a9c9bd9

chore(docs): Auto-update docs and licenses

fbd851c

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

fix: update logging method in WriteCounter to ensure progress message…

c177147

…s are captured correctly

fix: handle error when logging progress in WriteCounter

7d04c75

fix: remove unnecessary directory change in update-docs-and-licenses …

0cb1759

…script

fix: update documentation generation to use oms-cli.md for README

356a167

chore(docs): Auto-update docs and licenses

7d16506

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

Merge branch 'main' into automate_docs_and_license

401c180

chore(docs): Auto-update docs and licenses

1a48a9d

Signed-off-by: OliverTrautvetter <66372584+OliverTrautvetter@users.noreply.github.com>

OliverTrautvetter merged commit 61d9f87 into main Oct 23, 2025

OliverTrautvetter deleted the automate_docs_and_license branch October 23, 2025 11:26

Conversation

OliverTrautvetter commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

feat: Automate documentation and license updates

Uh oh!

NautiluX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

NautiluX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

NautiluX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

OliverTrautvetter commented Oct 17, 2025

Uh oh!

NautiluX commented Oct 17, 2025

Uh oh!

NautiluX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

OliverTrautvetter commented Oct 14, 2025 •

edited

Loading